<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::State Struct Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="structshark_1_1_state.html">State</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="structshark_1_1_state-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle"><div class="title">shark::State Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Represents the <a class="el" href="structshark_1_1_state.html" title="Represents the State of an Object.">State</a> of an Object.  
 <a href="structshark_1_1_state.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_state_8h_source.html">shark/Core/State.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for shark::State:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="structshark_1_1_state__inherit__graph.png" border="0" usemap="#ashark_1_1_state_inherit__map" alt="Inheritance graph"/></div>
<map name="ashark_1_1_state_inherit__map" id="ashark_1_1_state_inherit__map">
<area shape="rect" title="Represents the State of an Object." alt="" coords="110,5,202,31"/>
<area shape="rect" href="structshark_1_1_empty_state.html" title="Default State of an Object which does not need a State." alt="" coords="5,87,136,112"/>
<area shape="poly" title=" " alt="" coords="134,43,85,88,82,84,130,40"/>
<area shape="rect" href="structshark_1_1_normalizer_neuron_1_1_state.html" title=" " alt="" coords="159,79,326,120"/>
<area shape="poly" title=" " alt="" coords="182,40,223,77,219,81,178,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1214a001a7ebd5b22142a2cd1b58441f" id="r_a1214a001a7ebd5b22142a2cd1b58441f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structshark_1_1_state.html#a1214a001a7ebd5b22142a2cd1b58441f">~State</a> ()</td></tr>
<tr class="memdesc:a1214a001a7ebd5b22142a2cd1b58441f"><td class="mdescLeft">&#160;</td><td class="mdescRight">prevents that this class can be instantiated  <br /></td></tr>
<tr class="separator:a1214a001a7ebd5b22142a2cd1b58441f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9847e65e063245c6b02371c8b84f8da3" id="r_a9847e65e063245c6b02371c8b84f8da3"><td class="memTemplParams" colspan="2">template&lt;class DerivedStateType &gt; </td></tr>
<tr class="memitem:a9847e65e063245c6b02371c8b84f8da3"><td class="memTemplItemLeft" align="right" valign="top">DerivedStateType const &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structshark_1_1_state.html#a9847e65e063245c6b02371c8b84f8da3">toState</a> () const</td></tr>
<tr class="memdesc:a9847e65e063245c6b02371c8b84f8da3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safely downcast <a class="el" href="structshark_1_1_state.html" title="Represents the State of an Object.">State</a> to it's derived type.  <br /></td></tr>
<tr class="separator:a9847e65e063245c6b02371c8b84f8da3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6dd9bbeffc1942ae528cce76dbc8cc6" id="r_ad6dd9bbeffc1942ae528cce76dbc8cc6"><td class="memTemplParams" colspan="2">template&lt;class DerivedStateType &gt; </td></tr>
<tr class="memitem:ad6dd9bbeffc1942ae528cce76dbc8cc6"><td class="memTemplItemLeft" align="right" valign="top">DerivedStateType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structshark_1_1_state.html#ad6dd9bbeffc1942ae528cce76dbc8cc6">toState</a> ()</td></tr>
<tr class="separator:ad6dd9bbeffc1942ae528cce76dbc8cc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents the <a class="el" href="structshark_1_1_state.html" title="Represents the State of an Object.">State</a> of an Object. </p>
<p>Often the <a class="el" href="structshark_1_1_state.html" title="Represents the State of an Object.">State</a> of an object is changed during usage. This, however, makes it impossible to use the object in a multithreaded environment in parallel. The solution is to externalize the state, so that every thread can have it's own storage. </p>

<p class="definition">Definition at line <a class="el" href="_state_8h_source.html#l00049">49</a> of file <a class="el" href="_state_8h_source.html">State.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1214a001a7ebd5b22142a2cd1b58441f" name="a1214a001a7ebd5b22142a2cd1b58441f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1214a001a7ebd5b22142a2cd1b58441f">&#9670;&#160;</a></span>~State()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual shark::State::~State </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>prevents that this class can be instantiated </p>

<p class="definition">Definition at line <a class="el" href="_state_8h_source.html#l00052">52</a> of file <a class="el" href="_state_8h_source.html">State.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad6dd9bbeffc1942ae528cce76dbc8cc6" name="ad6dd9bbeffc1942ae528cce76dbc8cc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6dd9bbeffc1942ae528cce76dbc8cc6">&#9670;&#160;</a></span>toState() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DerivedStateType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">DerivedStateType &amp; shark::State::toState </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_state_8h_source.html#l00065">65</a> of file <a class="el" href="_state_8h_source.html">State.h</a>.</p>

</div>
</div>
<a id="a9847e65e063245c6b02371c8b84f8da3" name="a9847e65e063245c6b02371c8b84f8da3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9847e65e063245c6b02371c8b84f8da3">&#9670;&#160;</a></span>toState() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class DerivedStateType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">DerivedStateType const  &amp; shark::State::toState </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Safely downcast <a class="el" href="structshark_1_1_state.html" title="Represents the State of an Object.">State</a> to it's derived type. </p>
<p>Tries to do a safe cast from <a class="el" href="structshark_1_1_state.html" title="Represents the State of an Object.">State</a> to it's derived type. The program is terminated in debug mode, if the wrong Type was used. </p>

<p class="definition">Definition at line <a class="el" href="_state_8h_source.html#l00060">60</a> of file <a class="el" href="_state_8h_source.html">State.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_conv2_d_model.html#a8465955f88c4eeb452342583b2dcb3d3">shark::Conv2DModel&lt; VectorType, ActivationFunction &gt;::eval()</a>, <a class="el" href="classshark_1_1_dropout_layer.html#af5f9f6f4a84a406ea1153de2e634531c">shark::DropoutLayer&lt; VectorType &gt;::eval()</a>, <a class="el" href="classshark_1_1_linear_model.html#a64719fbce6e8de9fdc79ccc6d0535d79">shark::LinearModel&lt; InputType, ActivationFunction &gt;::eval()</a>, <a class="el" href="classshark_1_1_neuron_layer.html#afa565afbf5a904a24b41bbd6bca97d40">shark::NeuronLayer&lt; NeuronType, VectorType &gt;::eval()</a>, <a class="el" href="classshark_1_1_concatenated_model.html#a6ff8dcfccb5d9c3d10ef5c94b66ce9e9">shark::ConcatenatedModel&lt; VectorType &gt;::eval()</a>, <a class="el" href="classshark_1_1_a_r_d_kernel_unconstrained.html#a0a5bad6df6b7b7f7fc2ea28b50c7b97b">shark::ARDKernelUnconstrained&lt; InputType &gt;::eval()</a>, <a class="el" href="classshark_1_1_gaussian_rbf_kernel.html#a055097b043074a5113dc7cb42d506cd9">shark::GaussianRbfKernel&lt; InputType &gt;::eval()</a>, <a class="el" href="classshark_1_1_monomial_kernel.html#a0c72dc55c7aac6aa0399eae657f2a0cd">shark::MonomialKernel&lt; InputType &gt;::eval()</a>, <a class="el" href="classshark_1_1_polynomial_kernel.html#a09efbca8f80e43abd8a6bd1cb600da63">shark::PolynomialKernel&lt; InputType &gt;::eval()</a>, <a class="el" href="classshark_1_1_weighted_sum_kernel.html#ad58a7538e994a5d0a0b5d49e7d582f87">shark::WeightedSumKernel&lt; InputType &gt;::eval()</a>, <a class="el" href="classshark_1_1_normalized_kernel.html#a766bf8a238a55a1bdc08886133526a29">shark::NormalizedKernel&lt; InputType &gt;::eval()</a>, <a class="el" href="classshark_1_1_point_set_kernel.html#adfef05b52b18fb9fb8988e9585e2ff71">shark::PointSetKernel&lt; InputType &gt;::eval()</a>, <a class="el" href="classshark_1_1_concatenated_model.html#abe9f2ff98caaab06fdd9920355549e68">shark::ConcatenatedModel&lt; VectorType &gt;::hiddenResponses()</a>, <a class="el" href="classshark_1_1_concatenated_model.html#ab8afe252971bc0d46027d6bba8f861d7">shark::ConcatenatedModel&lt; VectorType &gt;::hiddenState()</a>, <a class="el" href="classshark_1_1_concatenated_model.html#a46b3208ecf225b142517c82c190a31b5">shark::ConcatenatedModel&lt; VectorType &gt;::weightedDerivatives()</a>, <a class="el" href="classshark_1_1_linear_model.html#a5019b360632186848424561bcb49bcb7">shark::LinearModel&lt; InputType, ActivationFunction &gt;::weightedDerivatives()</a>, <a class="el" href="classshark_1_1_neuron_layer.html#a704f5a3c5c80639fff93fc55ef1a474d">shark::NeuronLayer&lt; NeuronType, VectorType &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_conv2_d_model.html#a58ea7c864d76478c172a7e7799ad816d">shark::Conv2DModel&lt; VectorType, ActivationFunction &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_dropout_layer.html#a3c09852df31dd53eca754ded34fe5531">shark::DropoutLayer&lt; VectorType &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_concatenated_model.html#a881aa5af1b43ab5ffce47d2a44cc1b32">shark::ConcatenatedModel&lt; VectorType &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_linear_model.html#a453cbfdae76a34c3bef4de54246f2a15">shark::LinearModel&lt; InputType, ActivationFunction &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_a_r_d_kernel_unconstrained.html#af6ecdacc02a669cdb85a59ffa50fed31">shark::ARDKernelUnconstrained&lt; InputType &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_gaussian_rbf_kernel.html#a31bb55db7ececca83348244ce1d20a78">shark::GaussianRbfKernel&lt; InputType &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_monomial_kernel.html#afbcbbc68770e4ffe79cfdec7254598c6">shark::MonomialKernel&lt; InputType &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_polynomial_kernel.html#a19aced1c84b714199b4d30ebd86b0656">shark::PolynomialKernel&lt; InputType &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_normalized_kernel.html#a78299d1e57af5a48afab449ad248f80f">shark::NormalizedKernel&lt; InputType &gt;::weightedInputDerivative()</a>, <a class="el" href="classshark_1_1_weighted_sum_kernel.html#a8b3fc6653bb38681f0292d81251103a4">shark::WeightedSumKernel&lt; InputType &gt;::weightedInputDerivativeImpl()</a>, <a class="el" href="classshark_1_1_conv2_d_model.html#a7e08e22875a1316ee70df6fb857900c6">shark::Conv2DModel&lt; VectorType, ActivationFunction &gt;::weightedParameterDerivative()</a>, <a class="el" href="classshark_1_1_concatenated_model.html#a5a81b3d399d907f1dc6ea0ccc1e6af32">shark::ConcatenatedModel&lt; VectorType &gt;::weightedParameterDerivative()</a>, <a class="el" href="classshark_1_1_linear_model.html#a6e9fdbdec8a3eeef0aa6d6bcbb6a917e">shark::LinearModel&lt; InputType, ActivationFunction &gt;::weightedParameterDerivative()</a>, <a class="el" href="classshark_1_1_a_r_d_kernel_unconstrained.html#a2788b71608aaeb04b65e35bce58169e0">shark::ARDKernelUnconstrained&lt; InputType &gt;::weightedParameterDerivative()</a>, <a class="el" href="classshark_1_1_gaussian_rbf_kernel.html#ae3fafcbea6b5beb05aa0474f02ae5f3f">shark::GaussianRbfKernel&lt; InputType &gt;::weightedParameterDerivative()</a>, <a class="el" href="classshark_1_1_polynomial_kernel.html#a540870bc48d3e34c609f896e628c8bf6">shark::PolynomialKernel&lt; InputType &gt;::weightedParameterDerivative()</a>, <a class="el" href="classshark_1_1_weighted_sum_kernel.html#a32e469b9516edfadd503609e68c2ab4a">shark::WeightedSumKernel&lt; InputType &gt;::weightedParameterDerivative()</a>, <a class="el" href="classshark_1_1_normalized_kernel.html#a3e93a1c512126fb0ad7d098dc7c03eb7">shark::NormalizedKernel&lt; InputType &gt;::weightedParameterDerivative()</a>, and <a class="el" href="classshark_1_1_point_set_kernel.html#ae18f754e67f7b59cade8e26437a1cf39">shark::PointSetKernel&lt; InputType &gt;::weightedParameterDerivative()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/shark/Core/<a class="el" href="_state_8h_source.html">State.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
